Request parameters

Structr’s HTTP API supports a number of custom request parameters to influence the behaviour of the endpoints.

Key Name Description
_page Page number Request parameter used for pagination, sets the page number, value can be any positive integer > 0.
_pageSize Page size Request parameter used for pagination, sets the page size.
_sort Sort key Request parameter used for sorting, sets the sort key.
_order Sort order Request parameter used for sorting, sets the sort order, value can be ‘asc’ or ‘desc’ for ascending or descending order.
_inexact Search type Request parameter that activates inexact search.
_latlon Latitude/Longitude Request parameter used for distance search, specifies the center point of the distance search in the form latitude,longitude.
_location Location (country, city, street) Request parameter used for distance search, specifies the center point of the distance search in the form country,city,street.
_country Country Request parameter used for distance search, specifies the center point of the search circle together with _postalCode, _city, _street.
_postalCode Postal code Request parameter used for distance search, specifies the center point of the search circle together with _country, _city, _street.
_city City Request parameter used for distance search, specifies the center point of the search circle together with _country, _postalCode, _street.
_street Street Request parameter used for distance search, specifies the center point of the search circle together with _country, _postalCode, _city.
_distance Distance in kilometers Request parameter used for distance search, specifies the radius of the search circle.
_outputNestingDepth JSON Nesting Depth You can control how deeply nested objects are serialized in REST responses using the _outputNestingDepth request parameter. By default, Structr serializes nested objects to a depth of three levels, but increasing the nesting depth includes more levels of related objects in the response. This is useful when you need to access deeply nested relationships without making multiple requests.
_filename Download filename Request parameter that sets the ‘filename’ part of the Content-Disposition: attachment response header.
_as-data-url Download as data URL Request parameter that controls the response format of a file download. If set (with any value), it causes the file data to be returned in Base64 format ready to be used in a data URL.
_locale Locale Request parameter that overrides the locale for the current request.

Markdown Rendering Hint: Children of Topic(Request parameters) not rendered because MarkdownTableFormatter prevents rendering of children.